Best Practice Attestation

Introduction

The Best Practice Attestation Schema extends the generic Attestation Schema to enable attestations related to best practice. By referencing best practice details such as the types of best practice followed and has the flexibility for other details about the best practice measures taken to be recorded.

Description

This schema includes:

• Type: The attestation type, set to "Best_Practice".
• Best Practice Details: Provides details of the types of best practice followed, with free form option to include relevant details.

Use Case

The Best practice Attestation Schema is used to:

1. Document Best practice: Attach details of how best practice was followed to produce TAIBOM components, such as production of data, training of models and validation of trained models.
2. Track Adherence to Best Practice Recommendations: Keep track of components which have been reported to have been produced following best practice and trace whether best practice recommendations have been followed through the supply chain of producing an AI system.

This schema promotes transparency and accountability, ensuring that best practice has been followed through the supply chain.

Schemas

yaml

$id: https://github.com/nqminds/Trusted-AI-BOM/blob/main/packages/schemas/src/taibom-schemas/68-best-practice-attestation.v1.0.0.schema.yaml
$schema: https://json-schema.org/draft/2019-09/schema
title: Best Practice Attestation
description: |
  This schema extends the generic Attestation Schema to define an attestation that best practice has been followed was used in producing component
type: object
properties:
  component:
    type: object
    description: Component reference, including an ID and hash for the VC claim.
    properties:
      id:
        type: string
        description: The component ID (unique identifier) of the VC claim.
      hash:
        type: string
        description: Cryptographic hash (e.g., SHA-256) for verifying the integrity of the VC claim.
    required:
      - id
      - hash
  attestation:
    type: object
    properties:
      type:
        type: string
        enum:
          - best practice
        description: Type of attestation, set to "best practice" for this schema.
      best_practice:
        type: object
        description: Details of best practise followed
        properties:
          type:
            type: string
            description: The type of best practice followed (e.g. data curation, model selection, AI governance, cross-validation, QA before release)
          description:
            type: string
            description: How was best practise followed?
        required:
          - type
    required:
      - type
      - best_practice
required:
  - component
  - attestation

json

{
  "$id": "https://github.com/nqminds/Trusted-AI-BOM/blob/main/packages/schemas/src/taibom-schemas/68-best-practice-attestation.v1.0.0.schema.yaml",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "title": "Best Practice Attestation",
  "description": "This schema extends the generic Attestation Schema to define an attestation that best practice has been followed was used in producing component\n",
  "type": "object",
  "properties": {
    "component": {
      "type": "object",
      "description": "Component reference, including an ID and hash for the VC claim.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The component ID (unique identifier) of the VC claim."
        },
        "hash": {
          "type": "string",
          "description": "Cryptographic hash (e.g., SHA-256) for verifying the integrity of the VC claim."
        }
      },
      "required": [
        "id",
        "hash"
      ]
    },
    "attestation": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "best practice"
          ],
          "description": "Type of attestation, set to \"best practice\" for this schema."
        },
        "best_practice": {
          "type": "object",
          "description": "Details of best practise followed",
          "properties": {
            "type": {
              "type": "string",
              "description": "The type of best practice followed (e.g. data curation, model selection, AI governance, cross-validation, QA before release)"
            },
            "description": {
              "type": "string",
              "description": "How was best practise followed?"
            }
          },
          "required": [
            "type"
          ]
        }
      },
      "required": [
        "type",
        "best_practice"
      ]
    }
  },
  "required": [
    "component",
    "attestation"
  ]
}

markdown

Best Practice Attestation

This schema extends the generic Attestation Schema to define an attestation that best practice has been followed was used in producing component

The schema defines the following properties:

component (object, required)

Component reference, including an ID and hash for the VC claim.

Properties of the component object:

id (string, required)

The component ID (unique identifier) of the VC claim.

hash (string, required)

Cryptographic hash (e.g., SHA-256) for verifying the integrity of the VC claim.

attestation (object, required)

Properties of the attestation object:

type (string, enum, required)

Type of attestation, set to "best practice" for this schema.

This element must be one of the following enum values:

• best practice

best_practice (object, required)

Details of best practise followed

Properties of the best_practice object:

type (string, required)

The type of best practice followed (e.g. data curation, model selection, AI governance, cross-validation, QA before release)

description (string)

How was best practise followed?

Examples

table

component	attestation
[object Object]	[object Object]

json

[
  {
    "component": {
      "id": "urn:uuid:222e3337-e89b-12d3-a456-426614174004",
      "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0"
    },
    "attestation": {
      "type": "best practice",
      "best_practice": {
        "type": "data curation",
        "description": "Data has been curated following best practice procedures as specified by Joe Blogs et al. in Data Curation Practises for Machine Learning"
      }
    }
  }
]

Edit this schema here